home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / qbbs / ravote40.zip / RAVOTE.DOC < prev    next >
Text File  |  1992-07-03  |  8KB  |  173 lines
  1.  
  2.  
  3.  
  4.                   ──────────────────────────────────────
  5.                                 RAVote 4.00
  6.  
  7.                  (C) Copyright 1991, 1992 by Brian Pirie
  8.                                  (1:243/8)
  9.  
  10.                   ──────────────────────────────────────
  11.  
  12.  
  13.           RAVote is a user-voting door for your BBS, that allows
  14.     users to create "polls" for other users to vote on. RAVote is very
  15.               easy to setup and use, and is absoloutely free!
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.        ┌─ SETTING UP RAVOTE ─┐
  23.        └─────────────────────┘
  24.  
  25.                RAVote is probably the easiest door you'll ever setup!
  26.        All you have to do is to copy RAVOTE.EXE to your BBS system
  27.        directory, and setup your BBS to load it as you would any other
  28.        door - that's all there is to it!
  29.  
  30.  
  31.  
  32.  
  33.        ┌─ RUNNING RAVOTE ─┐
  34.        └──────────────────┘
  35.  
  36.                The RAVote door behaves similarly to most other door
  37.        programs. What you see in the output window is identical to what
  38.        the user on remote will be seeing. If the user has ANSI mode
  39.        turned on, you will see the same colors as they do, and if they
  40.        have screen clearing turned on, your screen will clear when
  41.        their's does. The status line at the bottom of the screen will
  42.        list the name of the user currently on-line (if you're using the
  43.        sample DORINFO1.DEF file, the user's name will be "The Sysop"),
  44.        the user's location, and the user's baud rate (0 if the door is
  45.        operating in local mode). You will also be told how much time the
  46.        user has left, and there will be indicators as to whether the
  47.        user has ANSI mode on, etc. If the user wishes to Chat with the
  48.        sysop (ie, they have paged the sysop, but haven't had a response
  49.        yet), a [Want-Chat] indicator will be flashing on the status
  50.        line. Try Paging the sysop, using OpenDoors built in sysop page
  51.        feature! The following function keys will also be available to
  52.        the sysop only in any OpenDoors door:
  53.  
  54.               []/[] - Use the arrow keys to increase or decrease how
  55.                         much time the user has left in the door.
  56.  
  57.             [Alt]-[C] - Allows the sysop to break into chat with the
  58.                         user at any time. [Alt]-[C] again, or [ESC] will
  59.                         end chat mode. (notice that the Want-Chat
  60.                         indicator will be turned off if it was flashing
  61.                         too. If your door is running under RemoteAccess
  62.                         or QuickBBS, paging from within the door will
  63.                         even cause the Want-Chat indicator to stay lit
  64.                         when the user returns to the BBS)
  65.  
  66.             [Alt]-[J] - Allows the sysop to shell to DOS, if enough
  67.                         memory is available. Simply type EXIT to return
  68.                         to the door again.
  69.  
  70.             [Alt]-[H] - Hangup on the user. When the sysop does this,
  71.                         OpenDoors will optionally call a function you
  72.                         have indicated in the OpenDoors control
  73.                         structure, to allow you to close files, etc.
  74.                         OpenDoors will then exit to a batch file with
  75.                         the appropriate errorlevel:
  76.  
  77.                               0 - A critical error has occurred
  78.                               1 - Carrier lost, user off-line
  79.                               2 - Sysop terminated call, user off-line
  80.                               3 - User time used up, user STILL ON-LINE
  81.                               4 - Keyboard inactivity timeout, user
  82.                                   off-line
  83.                           5-255 - Defined by your door
  84.  
  85.                         These errorlevel will allow users of your door
  86.                         to optionally log the user back on-line, place
  87.                         the BBS in "wait for call" mode, or whatever
  88.                         they wish, depending on how the door exited
  89.  
  90.             [Alt]-[L] - This nasty key locks the user out of the BBS. It
  91.                         first hangs up on the user, and then sets their
  92.                         security level to 0, to prevent them from ever
  93.                         logging on again. This feature may require use
  94.                         of the EXITINFO.BBS file, depending on what
  95.                         system the door is running under.
  96.  
  97.             [Alt]-[K] - The "User Keyboard-Off" key, will allow the
  98.                         sysop to temporarily prevent the user from
  99.                         typing anything on his keyboard. This has no
  100.                         effect on the local keyboard, but causes
  101.                         OpenDoors to ignore any keystrokes from remote.
  102.  
  103.             [Alt]-[N] - The "Sysop Next" key, this function reserves the
  104.                         system for use by the sysop after the user logs
  105.                         off, if the door is running under an RA 1.00 or
  106.                         compatible system.
  107.  
  108.             [Alt]-[D] - "Drop to BBS" key. This function allows the sysop
  109.                         to exit the door and return the user to the BBS,
  110.                         without hanging up.
  111.  
  112.  
  113.        Note: You may create your own menu for RAVote by creating the
  114.        files RAVOTE.ASC/RAVOTE.ANS/RAVOTE.AVT.
  115.  
  116.  
  117.  
  118.  
  119.  
  120.        ┌─ USER CHOICES FROM WITHIN RAVOTE ─┐
  121.        └───────────────────────────────────┘
  122.  
  123.                When running the RAVote program the user may choose the
  124.         following choices from the menu:
  125.  
  126.            Vote on topic - This allows the user to vote on a poll that
  127.                    has been created by another user, which they have not
  128.                    already answered. The user may add their own choice
  129.                    to the poll by choosing the "Other" command and
  130.                    adding another answer to the topic.
  131.  
  132.            Results - This allows the user to see the results of any of
  133.                    the polls that they have already voted on (they can't
  134.                    see the results of items which they haven't voted on,
  135.                    as this might influence their decision). RAVote will
  136.                    list the percentage of users who have voted on each
  137.                    topic, along with a small graph representing each
  138.                    choice's popularity.
  139.  
  140.            Add a Topic - This allows the user to create their own poll
  141.                    for other users to vote on. They will be able to
  142.                    enter a title, question, and possible answers.
  143.  
  144.            Page sysop - This allows the user to page the sysop for chat.
  145.  
  146.            Exit Door - This command will return the user to the BBS.
  147.  
  148.            Goodbye - This command will log the user off of the BBS
  149.  
  150.            Delete Item - This command, which is ONLY available to the
  151.                    SYSOP will allow certain topics to be deleted (say
  152.                    those which are old or in bad taste.)
  153.  
  154.  
  155.  
  156.        ┌─ SOURCE CODE ─┐
  157.        └───────────────┘
  158.  
  159.                Included in this archive is the source code for RAVote.
  160.        If you wish to recompile any changes that you make to the RAVote
  161.        source code, you must have a copy of OpenDoors, the "doordriver"
  162.        utility that RAVote is written in. OpenDoors is a complete
  163.        library for Turbo C, Turbo C++ and Borland C++ programmers for
  164.        quickly and easily creating doors. OpenDoors handles all of the
  165.        details of door programming for you, to allow you to concentrate
  166.        on the door itself (take a look at the RAVote source code to see
  167.        how easy door programming is with OpenDoors!). The new version of
  168.        OpenDoors will also have a complete set of routines for
  169.        manipulating Remote Access system, configuration, user and
  170.        message base files! If you would like the newest copy of
  171.        OpenDoors, feel free to request ODOORS*.* from 1:243/8, or log onto
  172.        the BBS at +1 613 526 4466.
  173.